/**
 *    Copyright 2009-2019 the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.apache.ibatis.reflection.wrapper;

import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.reflection.factory.ObjectFactory;
import org.apache.ibatis.reflection.property.PropertyTokenizer;

import java.util.List;

/**
 * 对象包装器
 * <p>
 * 包装对象后提供统一的属性操作方法。
 *
 * @author Clinton Begin
 */
public interface ObjectWrapper {

    /**
     * 根据属性名称描述符获取指定属性的值
     *
     * @param prop 属性名称描述符
     * @return 指定属性的值
     */
    Object get(PropertyTokenizer prop);

    /**
     * 根据属性名称描述符为指定的属性赋值
     *
     * @param prop  属性名称描述符
     * @param value 指定的值
     */
    void set(PropertyTokenizer prop, Object value);

    /**
     * 查找属性属性名称
     *
     * @param name                用于获取属性名的名称，比如可以通过name获取Name，或者Name获取name。
     * @param useCamelCaseMapping 是否使用驼峰命名法，即下划线转驼峰，比如通过first_name 获取firstName属性
     * @return 实际属性名称
     */
    String findProperty(String name, boolean useCamelCaseMapping);

    /**
     * 获取所有可读属性名
     *
     * @return 可读属性名集合
     */
    String[] getGetterNames();

    /**
     * 获取所有可写属性名
     *
     * @return 可写属性名集合
     */
    String[] getSetterNames();

    /**
     * 获取指定属性的setter方法入参类型
     *
     * @param name 属性名
     * @return 该属性setter方法入参类型
     */
    Class<?> getSetterType(String name);

    /**
     * 获取指定属性的getter方法返回类型
     *
     * @param name 属性名称
     * @return 该属性的getter方法的返回类型
     */
    Class<?> getGetterType(String name);

    /**
     * 是否有指定属性的setter方法
     *
     * @param name 属性名
     * @return 是否有指定属性的setter方法
     */
    boolean hasSetter(String name);

    /**
     * 是否有指定属性的getter方法
     *
     * @param name 属性名称
     * @return 是否有指定属性的getter方法
     */
    boolean hasGetter(String name);

    /**
     * 实例化某个属性的值，并获取对应的MetaObject对象
     *
     * @param name          完整的属性名
     * @param prop          属性名描述符
     * @param objectFactory 对象创建工厂
     * @return 指定的属性的值对应的MetaObject对象
     */
    MetaObject instantiatePropertyValue(String name, PropertyTokenizer prop, ObjectFactory objectFactory);

    /**
     * 判断被包装的对象是否是集合
     *
     * @return 被包装对象是否是集合
     */
    boolean isCollection();


    /**
     * 往被包装的集合对象中添加新的元素
     *
     * @param element 被添加的元素
     */
    void add(Object element);

    /**
     * 往被包装的集合对象中添加一组元素
     *
     * @param element 被添加的元素集合
     * @param <E>     元素类型
     */
    <E> void addAll(List<E> element);

}
